[GitHub Action] Automatically open a PR for `accepted` guideline issues #122

x0rw · 2025-05-31T01:11:44Z

Hey 👋.
This PR adds a workflow that automatically opens a PR for the accepted guidelines marked by 'accepted' label,
The script extracts the marked issue and parses it into a proper guideline rst file and appends this content into the appropriate chapter(eg. if the chapter is concurrency it will append the gl to src/coding-guidelines/concurreny.rst, note: the chapters title in here should be directly mapped to the names in coding-guidelines/ directory).

Tasks:

Workflow
Script takes the issue from stdin and turn it into our guidelines' .rst format
- Github Action can recieve the issue in json format through github.event.issue variable
- All issues are in this format: https://api.github.com/repos/x0rw/safety-critical-rust-coding-guidelines/issues/4
Review
Clean Up

How to test? :

Merge my branch into your forked main
Enable issues from your fork's settings.
Create an issue with the guideline template.
Add 'status: approved' label (create the label first).
Now check Actions tab to see a 'auto-pr' job running.
After a while there should be a new PR by GA.
For iterative testing, remove and reassign the 'sign-off: create pr from issue' label(make sure it's removed and added from the issue's timeline) and GA will force push again on the same PR.

Current Limitations

Markdown headings (e.g., ##) cannot be used inside content blocks in the issue template that are converted to reStructuredText (.rst) directives.
Use bold text or other alternatives for emphasis or headings within these blocks.

Why?

Because .rst format doesn't allow having headings nested inside directives.

netlify · 2025-05-31T01:11:48Z

✅ Deploy Preview for scrc-coding-guidelines ready!

Name	Link
🔨 Latest commit	`ceae2f7`
🔍 Latest deploy log	https://app.netlify.com/projects/scrc-coding-guidelines/deploys/6886bf05e4ef8400084cedca
😎 Deploy Preview	https://deploy-preview-122--scrc-coding-guidelines.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

PLeVasseur

Hey @x0rw thanks for taking this on. I haven't reviewed it in detail yet.
Noticed that you could use an existing label tho 👍

By the way, I see the build is failing -- is that intentional / expected?
I'd like to start reviewing once the build passes.

.github/workflows/auto-pr-on-issue.yml

x0rw · 2025-06-07T17:25:37Z

Hi @PLeVasseur.
The build failed because of the FLS difference checks. I guess it was fixed in a previous PR. You can re-run it, and it should work fine.

x0rw · 2025-06-07T17:31:54Z

Also, let me know when to remove those json test issues because i picked them randomly from my repo.

PLeVasseur · 2025-07-12T13:31:51Z

Hey @x0rw -- could you rebase? @darkwisebear recently update the spec lock file.

PLeVasseur · 2025-07-12T14:23:27Z

Could you help me become less ignorant? 😅

What's going on here?

Is it possible to enable anyone to try to auto-rebase?

Is it this the Automatic Rebase action or something else? (that action looks kinda nice...)

x0rw · 2025-07-12T14:36:09Z

What's going on here?

Is it possible to enable anyone to try to auto-rebase?

Is it this the Automatic Rebase action or something else? (that action looks kinda nice...)

Hey @PLeVasseur 😄
My local branch name is called github-action/auto-pr, i think that's what confused you.
When i rebase i simply do
git pull upstream main --rebase && git push origin "repo name" --force-with-lease,
but actually i think adding that Automatic Rebase /rebase command would be nice in here.

x0rw · 2025-07-12T14:40:59Z

@PLeVasseur,
This is rebased, and i squashed some of those testing commits.

PLeVasseur

Hey @x0rw -- sorry for the long delay 😅 I'm back from my "workation" in Japan and jumping back into reviews.

Bottom-line: I really like the concept and how you executed it.

Summary of feedback: As you can see from some of the comments I left, there's some refactoring that needs to be done to allow for easier maintenance in the future between both generate-guideline-templates.py and auto-pr-helper.py. Hope the rationale makes sense! 🙏

.github/workflows/auto-pr-on-issue.yml

scripts/auto-pr-helper.py

.github/workflows/auto-pr-on-issue.yml

scripts/auto-pr-helper.py

.github/workflows/auto-pr-on-issue.yml

scripts/auto-pr-helper.py

scripts/test_issue_sample.json

x0rw · 2025-07-12T23:15:38Z

About testing the auto-pr script, I went with snapshot testing approach, i compare the generated .rst template from issue json with the expected .rst result,
I added the correspondant test workflow that only triggers when you change relevant files/dirs.
About the test_issue_01/02,json i pulled them from my own issues(not personal issues) for testing, we can change them to issues from this repo and have them snapshotted.

PLeVasseur

Thanks for taking on the refactoring @x0rw! I've suggested some bits here that I think could help. Could you take a look?

.github/workflows/auto-pr-on-issue.yml

generate_guideline_templates.py

scripts/test_issue_sample.json

scripts/auto-pr-helper.py

.github/workflows/snapshot-ci.yml

PLeVasseur · 2025-07-25T20:11:39Z

Hi @x0rw -- could you rebase? I think this looks solid enough to merge then. 👍

test auto-pr template 2 test auto-pr template 3 test auto-pr template 4 test auto-pr template 5 test auto-pr template 6 test auto-pr template 7 test auto-pr template 8 test auto-pr template 9

Co-authored-by: Pete LeVasseur <[email protected]>

Fix 2 Fix 3 fix : special char i yml

add snapshot testing and their runner renamed generate-guideline-templates.py to generate_guideline_templates.py general refactor

Co-authored-by: Pete LeVasseur <[email protected]>

This workflow only triggers when the auto-pr script or the snapshot test directory changes

Co-authored-by: Pete LeVasseur <[email protected]>

x0rw · 2025-07-26T23:34:47Z

Hey @PLeVasseur, I'm testing ways to convert markdown directly into .rst format so that issue #156 can be transformed, with links, tables, highlights, bullet points without compromising readability in the issue form.
So tomorrow we can get this merged.

fix ci fix ci:

…napshots, update uv lock

x0rw · 2025-07-28T00:22:50Z

Hi @PLeVasseur,
This is ready for a live test, also check the Current Limitations section on this PR's description i just updated.

PLeVasseur

Nice, thanks for the contribution @x0rw ❤️

You could tackle this enhancement in another issue/PR:
it'd be nice to be able to support translating some syntax in the issue to a link to core/std as documented here.

PLeVasseur requested changes Jun 7, 2025

View reviewed changes

.github/workflows/auto-pr-on-issue.yml Outdated Show resolved Hide resolved

x0rw requested a review from PLeVasseur June 11, 2025 22:48

x0rw force-pushed the github-action/auto-pr branch 2 times, most recently from 34a4740 to 2d60b33 Compare July 12, 2025 14:02

PLeVasseur requested changes Jul 12, 2025

View reviewed changes

PLeVasseur mentioned this pull request Jul 12, 2025

[Coding Guideline]: Recursive function #135

Open

x0rw force-pushed the github-action/auto-pr branch from 36406c5 to b5c4829 Compare July 12, 2025 23:05

PLeVasseur requested changes Jul 13, 2025

View reviewed changes

x0rw and others added 13 commits July 26, 2025 19:15

Triger workflow

0e86d16

test auto-pr template

fa85086

test auto-pr template 2 test auto-pr template 3 test auto-pr template 4 test auto-pr template 5 test auto-pr template 6 test auto-pr template 7 test auto-pr template 8 test auto-pr template 9

chores: minor stuffs

e970422

chores: proper pr title

5072bb6

Add comments

53aaf2a

Update .github/workflows/auto-pr-on-issue.yml

1442007

Co-authored-by: Pete LeVasseur <[email protected]>

Fix

2c0a7c2

Fix 2 Fix 3 fix : special char i yml

Fix non compliant ex

14e0f8d

refactor: address code review

286b9c4

add snapshot testing and their runner renamed generate-guideline-templates.py to generate_guideline_templates.py general refactor

Fix workflow, use uv instead

49c32c7

Co-authored-by: Pete LeVasseur <[email protected]>

Add snapshot tests workflow

4a8ad42

This workflow only triggers when the auto-pr script or the snapshot test directory changes

Update .github/workflows/auto-pr-on-issue.yml

cbcfad5

Co-authored-by: Pete LeVasseur <[email protected]>

Apply suggestion from @PLeVasseur

f17f796

Co-authored-by: Pete LeVasseur <[email protected]>

x0rw and others added 8 commits July 26, 2025 19:15

Apply suggestion from @PLeVasseur

f5e756d

Co-authored-by: Pete LeVasseur <[email protected]>

address review comments

5b1d45b

test ci snapshot error

f4f0fe8

Fix issues, refactor dedent, update worflow to use astral actions

3bd6382

Fix ci

b2f598d

Inline compliant and non-compliant-exs in guideline template

81795ff

Address review comments and remove unused code

d2d5f53

ci: add co-author info from issue author in auto-generated PRs

e293ce3

x0rw added 4 commits July 28, 2025 00:17

feat: md to .rst, fix ci unstability

bf12b40

fix ci fix ci:

add m2r to pyproject.toml

fe1279b

fix double commit issue

86ab9d4

fix ci: merge dup with

9641978

x0rw force-pushed the github-action/auto-pr branch from c1ebb63 to 9641978 Compare July 27, 2025 23:18

x0rw added 5 commits July 28, 2025 00:43

fix: we assume that tags are already seperated in the issue, update s…

3cc0622

…napshots, update uv lock

Add snapshot tests readme.md

e3582f4

Add scripts/auto-pr-helper.py readme.md

d0e216e

feat: tag the original author in the PR itself

a52f883

update snapshots

ceae2f7

PLeVasseur approved these changes Jul 29, 2025

View reviewed changes

PLeVasseur added this pull request to the merge queue Jul 29, 2025

Merged via the queue into rustfoundation:main with commit 22aac67 Jul 29, 2025
6 checks passed

[GitHub Action] Automatically open a PR for accepted guideline issues #122

[GitHub Action] Automatically open a PR for accepted guideline issues #122

Conversation

x0rw commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tasks:

How to test? :

Current Limitations

Uh oh!

netlify bot commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for scrc-coding-guidelines ready!

Uh oh!

PLeVasseur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

x0rw commented Jun 7, 2025

Uh oh!

x0rw commented Jun 7, 2025

Uh oh!

PLeVasseur commented Jul 12, 2025

Uh oh!

PLeVasseur commented Jul 12, 2025

Uh oh!

x0rw commented Jul 12, 2025

Uh oh!

x0rw commented Jul 12, 2025

Uh oh!

PLeVasseur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

x0rw commented Jul 12, 2025

Uh oh!

PLeVasseur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PLeVasseur commented Jul 25, 2025

Uh oh!

x0rw commented Jul 26, 2025

Uh oh!

x0rw commented Jul 28, 2025

Uh oh!

PLeVasseur left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

[GitHub Action] Automatically open a PR for `accepted` guideline issues #122

[GitHub Action] Automatically open a PR for `accepted` guideline issues #122

x0rw commented May 31, 2025 •

edited

Loading

netlify bot commented May 31, 2025 •

edited

Loading

PLeVasseur left a comment •

edited

Loading